Skip to content

Support for Private Frontend on Application Gateway for Containers#44200

Open
saurabhale wants to merge 3 commits into
mainfrom
sabhale/trafficcontroller/privatefrontend
Open

Support for Private Frontend on Application Gateway for Containers#44200
saurabhale wants to merge 3 commits into
mainfrom
sabhale/trafficcontroller/privatefrontend

Conversation

@saurabhale

Copy link
Copy Markdown
Member

Add private frontend support for Application Gateway for Containers (Traffic Controllers):

  • FrontendType enum (public/private) and type property on FrontendProperties
  • Association reference on FrontendProperties for private frontends
  • PrivateEndpointConnection resources (Get, Update, Delete, List)
  • PrivateLinkResource resources (Get, List)
  • privateEndpointConnections on TrafficControllerProperties
  • PrivateLinkServiceConnectionState model for approve/reject flow
  • Updated readme.md with new API version tags

…iceNetworking

Add private frontend support for Application Gateway for Containers (Traffic Controllers):
- FrontendType enum (public/private) and type property on FrontendProperties
- Association reference on FrontendProperties for private frontends
- PrivateEndpointConnection resources (Get, Update, Delete, List)
- PrivateLinkResource resources (Get, List)
- privateEndpointConnections on TrafficControllerProperties
- PrivateLinkServiceConnectionState model for approve/reject flow
- Updated readme.md with new API version tags
@github-actions

github-actions Bot commented Jun 24, 2026

Copy link
Copy Markdown

Next Steps to Merge

Next steps that must be taken to merge this PR:
  • ❌ This PR targets either the main branch of the public specs repo or the RPSaaSMaster branch of the private specs repo. These branches are not intended for iterative development. Therefore, you must acknowledge you understand that after this PR is merged, the APIs are considered shipped to Azure customers. Any further attempts at in-place modifications to the APIs will be subject to Azure's versioning and breaking change policies. Additionally, for control plane APIs, you must acknowledge that you are following all the best practices documented by ARM at aka.ms/armapibestpractices. If you do intend to release the APIs to your customers by merging this PR, add the PublishToCustomers label to your PR in acknowledgement of the above. Otherwise, retarget this PR onto a feature branch, i.e. with prefix release- (see aka.ms/azsdk/api-versions#release--branches).
  • ❌ This PR is in purview of the ARM review (label: ARMReview). This PR must get ARMSignedOff label from an ARM reviewer.
    This PR is awaiting ARM reviewer feedback (label: WaitForARMFeedback).
    To learn when this PR will get reviewed, see ARM review queue at aka.ms/azsdk/pr-arm-review
    For details of the ARM review, see aka.ms/azsdk/pr-arm-review


Comment generated by summarize-checks workflow run.

@github-actions github-actions Bot added ARMModelingAutoSignedOff ARMReview new-api-version resource-manager TypeSpec Authored with TypeSpec WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required labels Jun 24, 2026
@github-actions

github-actions Bot commented Jun 24, 2026

Copy link
Copy Markdown

API Change Check

APIView identified API level changes in this PR and created the following API reviews

Language API Review for Package
Swagger Microsoft.ServiceNetworking-ServiceNetworking
JavaScript @azure/arm-servicenetworking
Python azure-mgmt-servicenetworking
TypeSpec Microsoft.ServiceNetworking
Go sdk/resourcemanager/servicenetworking/armservicenetworking
Java com.azure.resourcemanager:azure-resourcemanager-servicenetworking

Comment generated by After APIView workflow run.

@ravimeda ravimeda left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

ARM API Review

Posting findings from the ARM API Reviewer agent (critic-verified, 2 iterations, converged) against commit 2a1751e. See inline comments for findings 1-5.

"description": "Provisioning State of Traffic Controller Frontend Resource",
"readOnly": true
},
"type": {

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

[NEW] 🟠 Warning [ARM §2.5] stable/2026-03-01/TrafficController.json — line 1897 — property named type inside the properties bag shadows the ARM envelope type.

Classification reasoning: NEW — FrontendProperties.type is added in this PR (prior stable 2025-01-01 FrontendProperties had only fqdn and provisioningState).

Frontend uses x-ms-client-flatten: true (line 1849), so this type flattens onto the resource and collides with the ARM envelope type (the resource-type discriminator), causing SDK property-name collisions and client confusion. The same applies to FrontendUpdateProperties.type (line 1933). ARM §2.5 names type explicitly as a reserved envelope property.

Suggested fix: Rename to frontendType (update both FrontendType $ref usages and the example payloads).

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Added a suppression with reason: "The Frontend 'type' property is a domain enum (public/private) describing the frontend kind, distinct from the read-only ARM envelope resource 'type'; the two never conflict in request payloads and only co-appear in responses. The name matches the Microsoft.ServiceNetworking RP implementation, which serializes this value as 'properties.type'"

}
}
},
"PrivateEndpointConnection": {

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

[NEW] 🔵 Suggestion [ARM §2.8] stable/2026-03-01/TrafficController.json — line 2466 — Private Link types defined locally.

Classification reasoning: NEW — these definitions are introduced in this PR.

PrivateEndpointConnection, PrivateLinkResource, PrivateLinkServiceConnectionState, and PrivateEndpointReference are defined locally. They match the common-types shape (so this is non-blocking), but prefer $ref-ing the common-types Private Link definitions — or, in TypeSpec, the standard PrivateEndpointConnection / PrivateLinkResource ARM resource templates from @azure-tools/typespec-azure-resource-manager.

"$ref": "#/definitions/PrivateLinkServiceConnectionState",
"description": "The connection state of the private endpoint connection."
},
"provisioningState": {

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

[NEW] 🔵 Suggestion stable/2026-03-01/TrafficController.json — line 2516 — PEC provisioningState reuses the service-wide enum.

Classification reasoning: NEW — the privateEndpointConnections resource is introduced in this PR.

PrivateEndpointConnectionProperties.provisioningState reuses the service-wide ProvisioningState enum (Provisioning/Updating/Deleting/Accepted/Succeeded/Failed/Canceled) instead of the common-types PrivateEndpointConnectionProvisioningState (Succeeded/Creating/Deleting/Failed). Minor; consider the dedicated enum for the Private Endpoint Connection resource.

@ravimeda ravimeda added ARMChangesRequested and removed WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required labels Jun 25, 2026
- Add 201 response examples to PrivateEndpointConnectionPut for 2025-10-01-preview and 2026-03-01 (fixes ModelValidation RESPONSE_STATUS_CODE_NOT_IN_EXAMPLE)
- Add read-only provisioningState to PrivateLinkResourceProperties and regenerate swagger
- Suppress arm-resource-duplicate-property on FrontendProperties.type in TypeSpec; add LintDiff ArmResourcePropertiesBag suppression in readme.md so 'type' matches the shipped RP contract
- Add Location/Retry-After headers to PrivateEndpointConnectionDelete 202 examples (fixes ModelValidation LRO_RESPONSE_HEADER)
- Run tsp format on main.tsp and apply prettier formatting to examples
@saurabhale saurabhale force-pushed the sabhale/trafficcontroller/privatefrontend branch from 370f198 to 9c4bcc6 Compare July 6, 2026 21:13
@saurabhale saurabhale requested a review from ravimeda July 6, 2026 21:20
@saurabhale saurabhale added the WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required label Jul 6, 2026
@github-actions github-actions Bot removed the WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required label Jul 6, 2026
@saurabhale saurabhale added the WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required label Jul 6, 2026
@github-actions github-actions Bot removed the WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required label Jul 6, 2026
@github-actions github-actions Bot added the WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required label Jul 6, 2026
@microsoft-github-policy-service

Copy link
Copy Markdown
Contributor

@saurabhale please read the following Contributor License Agreement(CLA). If you agree with the CLA, please reply with the following information.

@microsoft-github-policy-service agree [company="{your company}"]

Options:

  • (default - no company specified) I have sole ownership of intellectual property rights to my Submissions and I am not making Submissions in the course of work for my employer.
@microsoft-github-policy-service agree
  • (when company given) I am making Submissions in the course of work for my employer (or my employer has intellectual property rights in my Submissions by contract or applicable law). I have permission from my employer to make Submissions and enter into this Agreement on behalf of my employer. By signing below, the defined term “You” includes me and my employer.
@microsoft-github-policy-service agree company="Microsoft"
Contributor License Agreement

Contribution License Agreement

This Contribution License Agreement (“Agreement”) is agreed to by the party signing below (“You”),
and conveys certain license rights to Microsoft Corporation and its affiliates (“Microsoft”) for Your
contributions to Microsoft open source projects. This Agreement is effective as of the latest signature
date below.

  1. Definitions.
    “Code” means the computer software code, whether in human-readable or machine-executable form,
    that is delivered by You to Microsoft under this Agreement.
    “Project” means any of the projects owned or managed by Microsoft and offered under a license
    approved by the Open Source Initiative (www.opensource.org).
    “Submit” is the act of uploading, submitting, transmitting, or distributing code or other content to any
    Project, including but not limited to communication on electronic mailing lists, source code control
    systems, and issue tracking systems that are managed by, or on behalf of, the Project for the purpose of
    discussing and improving that Project, but excluding communication that is conspicuously marked or
    otherwise designated in writing by You as “Not a Submission.”
    “Submission” means the Code and any other copyrightable material Submitted by You, including any
    associated comments and documentation.
  2. Your Submission. You must agree to the terms of this Agreement before making a Submission to any
    Project. This Agreement covers any and all Submissions that You, now or in the future (except as
    described in Section 4 below), Submit to any Project.
  3. Originality of Work. You represent that each of Your Submissions is entirely Your original work.
    Should You wish to Submit materials that are not Your original work, You may Submit them separately
    to the Project if You (a) retain all copyright and license information that was in the materials as You
    received them, (b) in the description accompanying Your Submission, include the phrase “Submission
    containing materials of a third party:” followed by the names of the third party and any licenses or other
    restrictions of which You are aware, and (c) follow any other instructions in the Project’s written
    guidelines concerning Submissions.
  4. Your Employer. References to “employer” in this Agreement include Your employer or anyone else
    for whom You are acting in making Your Submission, e.g. as a contractor, vendor, or agent. If Your
    Submission is made in the course of Your work for an employer or Your employer has intellectual
    property rights in Your Submission by contract or applicable law, You must secure permission from Your
    employer to make the Submission before signing this Agreement. In that case, the term “You” in this
    Agreement will refer to You and the employer collectively. If You change employers in the future and
    desire to Submit additional Submissions for the new employer, then You agree to sign a new Agreement
    and secure permission from the new employer before Submitting those Submissions.
  5. Licenses.
  • Copyright License. You grant Microsoft, and those who receive the Submission directly or
    indirectly from Microsoft, a perpetual, worldwide, non-exclusive, royalty-free, irrevocable license in the
    Submission to reproduce, prepare derivative works of, publicly display, publicly perform, and distribute
    the Submission and such derivative works, and to sublicense any or all of the foregoing rights to third
    parties.
  • Patent License. You grant Microsoft, and those who receive the Submission directly or
    indirectly from Microsoft, a perpetual, worldwide, non-exclusive, royalty-free, irrevocable license under
    Your patent claims that are necessarily infringed by the Submission or the combination of the
    Submission with the Project to which it was Submitted to make, have made, use, offer to sell, sell and
    import or otherwise dispose of the Submission alone or with the Project.
  • Other Rights Reserved. Each party reserves all rights not expressly granted in this Agreement.
    No additional licenses or rights whatsoever (including, without limitation, any implied licenses) are
    granted by implication, exhaustion, estoppel or otherwise.
  1. Representations and Warranties. You represent that You are legally entitled to grant the above
    licenses. You represent that each of Your Submissions is entirely Your original work (except as You may
    have disclosed under Section 3). You represent that You have secured permission from Your employer to
    make the Submission in cases where Your Submission is made in the course of Your work for Your
    employer or Your employer has intellectual property rights in Your Submission by contract or applicable
    law. If You are signing this Agreement on behalf of Your employer, You represent and warrant that You
    have the necessary authority to bind the listed employer to the obligations contained in this Agreement.
    You are not expected to provide support for Your Submission, unless You choose to do so. UNLESS
    REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING, AND EXCEPT FOR THE WARRANTIES
    EXPRESSLY STATED IN SECTIONS 3, 4, AND 6, THE SUBMISSION PROVIDED UNDER THIS AGREEMENT IS
    PROVIDED WITHOUT WARRANTY OF ANY KIND, INCLUDING, BUT NOT LIMITED TO, ANY WARRANTY OF
    NONINFRINGEMENT, MERCHANTABILITY, OR FITNESS FOR A PARTICULAR PURPOSE.
  2. Notice to Microsoft. You agree to notify Microsoft in writing of any facts or circumstances of which
    You later become aware that would make Your representations in this Agreement inaccurate in any
    respect.
  3. Information about Submissions. You agree that contributions to Projects and information about
    contributions may be maintained indefinitely and disclosed publicly, including Your name and other
    information that You submit with Your Submission.
  4. Governing Law/Jurisdiction. This Agreement is governed by the laws of the State of Washington, and
    the parties consent to exclusive jurisdiction and venue in the federal courts sitting in King County,
    Washington, unless no federal subject matter jurisdiction exists, in which case the parties consent to
    exclusive jurisdiction and venue in the Superior Court of King County, Washington. The parties waive all
    defenses of lack of personal jurisdiction and forum non-conveniens.
  5. Entire Agreement/Assignment. This Agreement is the entire agreement between the parties, and
    supersedes any and all prior agreements, understandings or communications, written or oral, between
    the parties relating to the subject matter hereof. This Agreement may be assigned by Microsoft.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants